home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 2002 November / SGI Freeware 2002 November - Disc 1.iso / dist / fw_cyrus-imapd.idb / usr / freeware / catman / u_man / cat5 / imapd.conf.Z / imapd.conf
Text File  |  2001-07-06  |  12KB  |  331 lines
  1.  
  2.  
  3.  
  4. IMAPD.CONF(5)                        IMAPD.CONF(5)
  5.  
  6.  
  7. NNAAMMEE
  8.        imapd.conf - IMAP configuration file
  9.  
  10. DDEESSCCRRIIPPTTIIOONN
  11.        //eettcc//iimmaappdd..ccoonnff    is  the     configuration file for    the Cyrus
  12.        IMAP server.  It    defines    local parameters for IMAP.
  13.  
  14.        Each line of the    //eettcc//iimmaappdd..ccoonnff    file has the form
  15.  
  16.           _o_p_t_i_o_n: _v_a_l_u_e
  17.  
  18.        where _o_p_t_i_o_n is the name    of the configuration option being
  19.        set  and     _v_a_l_u_e is the value that the configuration option
  20.        is being    set to.
  21.  
  22.        Blank lines and lines beginning with ``#'' are ignored.
  23.  
  24.        For boolean options, the    values    ``yes'',  ``on'',  ``t'',
  25.        and  ``1'' turn the option on, the values ``no'', ``off'',
  26.        ``f'', and ``0''    turn the option    off.
  27.  
  28. FFIIEELLDD DDEESSCCRRIIPPTTIIOONNSS
  29.        The sections below detail options that can  be  placed  in
  30.        the  //eettcc//iimmaappdd..ccoonnff  file, and show each option's default
  31.        value.  Some options have  no  default  value,  these  are
  32.        listed with ``<no default>''.  Some options default to the
  33.        empty string, these are listed with ``<none>''.
  34.  
  35.        ccoonnffiiggddiirreeccttoorryy::    <no default>
  36.         The    pathname of  the  IMAP    configuration  directory.
  37.         This field is required.
  38.  
  39.        ddeeffaauullttppaarrttiittiioonn:: default
  40.         The    partition name used by default for new mailboxes.
  41.  
  42.        ppaarrttiittiioonn--_n_a_m_e:: <no default>
  43.         The    pathname of the    partition  _n_a_m_e.   At  least  one
  44.         field,  for     the partition named in    the ddeeffaauullttppaarrttii
  45.         ttiioonn option, is required.  For example, if the  value
  46.         of    the  ddeeffaauullttppaarrttiioonn  option  is    ddeeffaauulltt, then the
  47.         ppaarrttiittiioonn--ddeeffaauulltt field is required.
  48.  
  49.        uummaasskk:: 077
  50.         The    umask value used by various Cyrus IMAP    programs.
  51.  
  52.        sseerrvveerrnnaammee:: <result returned by gethostname(2)>
  53.         This is the    hostname visible in the    greeting messages
  54.         of the POP,    IMAP and LMTP daemons. If  it  is  unset,
  55.         then the result returned from gethostname(2) is used.
  56.  
  57.        aalllloowwaannoonnyymmoouussllooggiinn:: no
  58.         Permit logins by the user "anonymous" using    any pass
  59.         word.   Also  allows use of    the SASL ANONYMOUS mecha
  60.         nism.
  61.  
  62.  
  63.  
  64. CMU              Project Cyrus                1
  65.  
  66.  
  67.  
  68.  
  69.  
  70. IMAPD.CONF(5)                        IMAPD.CONF(5)
  71.  
  72.  
  73.        aalllloowwppllaaiinntteexxtt:: yes
  74.         Allow the use of the SASL PLAIN mechanism.
  75.  
  76.        qquuoottaawwaarrnn:: 90
  77.         The    percent     of  quota  utilization     over  which  the
  78.         server generates warnings.
  79.  
  80.        ttiimmeeoouutt::    30
  81.         The    length of the IMAP server's inactivity autologout
  82.         timer, in minutes.    The  minimum  value  is     30,  the
  83.         default.
  84.  
  85.        iimmaappiiddlleeppoollll:: 60
  86.         The    interval (in seconds) for polling the mailbox for
  87.         changes while running the IDLE command.  This  option
  88.         is    used  when  idled  can    not  be    contacted or when
  89.         polling is used exclusively.  The minimum value is 1.
  90.         A  value  of 0 will    disable    polling    (and disable IDLE
  91.         if polling is the only method available).
  92.  
  93.        iimmaappiiddrreessppoonnssee:: yes
  94.         If enabled,    the server responds to an ID command with
  95.         a  parameter  list    containing: version, vendor, sup
  96.         port-url, os, os-version, command,    arguments,  envi
  97.         ronment.  Otherwise    the server returns NIL.
  98.  
  99.        ppooppttiimmeeoouutt:: 10
  100.         Set    the length of the POP server's inactivity autolo
  101.         gout timer,    in minutes.  The minimum value is 10, the
  102.         default.
  103.  
  104.        ppooppmmiinnppoollll:: 0
  105.         Set     the  minimum  amount  of  time    the server forces
  106.         users to wait between successive POP logins, in  min
  107.         utes.  The default is 0.
  108.  
  109.        ppooppeexxppiirreettiimmee:: 0
  110.         The     number    of days    advertised as being the    minimum    a
  111.         message may    be left    on the POP server  before  it  is
  112.         deleted  (via  the    CAPA command, defined in the POP3
  113.         Extension Mechanism, which some clients may    support).
  114.         "NEVER",  the  default, may    be specified with a nega
  115.         tive number.  The Cyrus  POP3  server  never  deletes
  116.         mail,  no matter what the value of this parameter is.
  117.         However, if    a site implements a less liberal  policy,
  118.         it needs to    change this parameter accordingly.
  119.  
  120.        aaddmmiinnss:: <none>
  121.         The    list of    userids    with administrative rights.  Sep
  122.         arate each userid with a space.  Sites using Kerberos
  123.         authentication may use separate "admin" instances.
  124.  
  125.        Note that accounts used by users    should not be administra
  126.        tors.  Administrative accounts should  not  receive  mail.
  127.  
  128.  
  129.  
  130. CMU              Project Cyrus                2
  131.  
  132.  
  133.  
  134.  
  135.  
  136. IMAPD.CONF(5)                        IMAPD.CONF(5)
  137.  
  138.  
  139.        That  is, if user "jbRo"    is a user reading mail,    he should
  140.        not also    be in the admins line.    Some problems  may  occur
  141.        otherwise,  most    notably     the ability of    administrators to
  142.        create top-level     mailboxes  visible  to     users,     but  not
  143.        writable    by users.
  144.  
  145.        pprrooxxyysseerrvveerrss:: <none>
  146.         A  list of users and groups    that are allowed to proxy
  147.         for    other  users,  seperated  by  spaces.    Any  user
  148.         listed in this will    be allowed to login for    any other
  149.         user: use with caution.
  150.  
  151.        ddeeffaauullttaaccll:: anyone lrs
  152.         The    Access Control List (ACL) placed on a  newly-cre
  153.         ated  (non-user)  mailbox that does    not have a parent
  154.         mailbox.
  155.  
  156.        nneewwssssppooooll:: <no default>
  157.         The    pathname of the    news spool directory.  Only  used
  158.         if the ppaarrttiittiioonn--nneewwss configuration    option is set.
  159.  
  160.        nneewwsspprreeffiixx:: <none>
  161.         Prefix to be prepended to newsgroup    names to make the
  162.         corresponding IMAP mailbox names.
  163.  
  164.        aauuttooccrreeaatteeqquuoottaa::    0
  165.         If nonzero,    normal users may create     their    own  IMAP
  166.         accounts  by  creating the mailbox INBOX.  The user's
  167.         quota is set to the    value if it is    positive,  other
  168.         wise the user has unlimited    quota.
  169.  
  170.        llooggttiimmeessttaammppss:: no
  171.         Include  notations    in  the     protocol  telemetry logs
  172.         indicating the number of seconds since the last  com
  173.         mand or response.
  174.  
  175.        ppllaaiinntteexxttllooggiinnppaauussee:: 0
  176.         Number  of seconds to pause    after a    successful plain
  177.         text login.     For systems that support strong  authen
  178.         tication,  this  permits  users to perceive    a cost of
  179.         using plaintext passwords.    (This does not effect the
  180.         use    of PLAIN in SASL authentications.)
  181.  
  182.        ssrrvvttaabb:: /etc/srvtab
  183.         The     pathname  of _s_r_v_t_a_b file containing the server's
  184.         private key.  This    option    is  passed  to    the  SASL
  185.         library and    overrides its default setting.
  186.  
  187.        llooggiinnrreeaallmmss:: <none>
  188.         The     list  of  remote  realms  whose users may log in
  189.         using  cross-realm    authentications.   Seperate  each
  190.         realm  name     by  a space.  (A cross-realm identity is
  191.         considered any identity returned by    SASL with an  "@"
  192.         in it.)
  193.  
  194.  
  195.  
  196. CMU              Project Cyrus                3
  197.  
  198.  
  199.  
  200.  
  201.  
  202. IMAPD.CONF(5)                        IMAPD.CONF(5)
  203.  
  204.  
  205.        llooggiinnuusseeaaccll:: no
  206.         If    enabled,  any authentication identity which has    aa
  207.         rights on a    user's INBOX may log in    as that    user.
  208.  
  209.        ssiinngglleeiinnssttaanncceessttoorree:: yes
  210.         If enabled,    deliver    running    in LMTP    mode attempts  to
  211.         only  write     one  copy of a    message    per partition and
  212.         create hard    links, resulting in a  potentially  large
  213.         disk savings.
  214.  
  215.        rreejjeecctt88bbiitt:: no
  216.         If enabled,    deliver    rejects    messages with 8-bit char
  217.         acters in the headers.  Otherwise,    8-bit  characters
  218.         are     changed to `X'.  (A proper soultion to    non-ASCII
  219.         characters in headers is offered by    RFC 2047 and  its
  220.         predecessors.)
  221.  
  222.        ppoossttuusseerr:: <none>
  223.         Userid  used  to  deliver messages to shared folders.
  224.         For     example,  if  set  to    "bb",    email    sent   to
  225.         "bb+shared.blah"    would    be   delivered     to   the
  226.         "shared.blah" folder.  By default, an  email  address
  227.         of "+shared.blah" would be used.
  228.  
  229.        nneettssccaappeeuurrll::
  230.        http://andrew2.andrew.cmu.edu/cyrus/imapd/netscape-
  231.        admin.html
  232.         If enabled at compile time,    this specifies a  URL  to
  233.         reply  when     Netscape  asks    the server where the mail
  234.         administration HTTP    server is.  The    default    is a site
  235.         at CMU with    a hopefully informative    message; adminis
  236.         trators should set this to a local resource    with some
  237.         information    of greater use.
  238.  
  239.        ssiieevveeuusseehhoommeeddiirr::    false
  240.         If    enabled,  deliver  will    look for Sieve scripts in
  241.         user's home    directories: ~user/.sieve.
  242.  
  243.        ssiieevveeddiirr:: /usr/sieve
  244.         If    sieveusehomedir     is  false,  this  directory   is
  245.         searched for Sieve scripts.
  246.  
  247.        sseennddmmaaiill:: /usr/lib/sendmail
  248.         The     pathname of the sendmail executable.  Sieve uses
  249.         sendmail for sending rejections, redirects and  vaca
  250.         tion responses.
  251.  
  252.        ppoossttmmaasstteerr:: postmaster
  253.         Username that is used as the 'From'    address    in rejec
  254.         tion MDNs produced by sieve.
  255.  
  256.        hhaasshhiimmaappssppooooll:: false
  257.         If enabled,    the partitions will also  be  hashed,  in
  258.         addition   to   the     hashing  done    on  configuration
  259.  
  260.  
  261.  
  262. CMU              Project Cyrus                4
  263.  
  264.  
  265.  
  266.  
  267.  
  268. IMAPD.CONF(5)                        IMAPD.CONF(5)
  269.  
  270.  
  271.         directories.  This is recommended  if  one    partition
  272.         has    a very bushy mailbox tree.
  273.  
  274.        ssiieevvee__mmaaxxssccrriippttssiizzee:: 32
  275.         Maximum  size (in kilobytes) any sieve script can be,
  276.         enforced at    submission by timsieved(8).
  277.  
  278.        ssiieevvee__mmaaxxssccrriippttss:: 5
  279.         Maximum number of sieve scripts any     user  may  have,
  280.         enforced at    submission by timsieved(8).
  281.  
  282.        ssaassll__mmaaxxiimmuumm__llaayyeerr:: 256
  283.         Maximum  SSF  (security  strength  factor)    that  the
  284.         server will    allow a    client to negotiate.
  285.  
  286.        ssaassll__mmiinniimmuumm__llaayyeerr:: 0
  287.         The    minimum    SSF that the server will allow    a  client
  288.         to    negotiate.   A value of    1 requires integrity pro
  289.         tection; any higher    value  requires     some  amount  of
  290.         encryption.
  291.  
  292.        ssaassll__ppwwcchheecckk__mmeetthhoodd:: PAM
  293.         The     mechanism used    by the server to verify    plaintext
  294.         passwords.    Possible values     also  include    "sasldb",
  295.         "kerberos_v4", "passwd", and "shadow".
  296.  
  297.        ssaassll__aauuttoo__ttrraannssiittiioonn:: no
  298.         If    enabled, the SASL library will automatically cre
  299.         ate    authentication secrets    when  given  a    plaintext
  300.         password.  See the SASL documentation.
  301.  
  302.        ssaassll__ooppttiioonn
  303.         Any     other    SASL  option  can be set by preceeding it
  304.         with "sasl_".  This    file overrides the SASL     configu
  305.         ration file.
  306.  
  307.        llmmttppssoocckkeett:: /var/imap/socket/lmtp
  308.         Unix domain    socket that lmtpd listens on.
  309.  
  310.        iiddlleessoocckkeett:: /var/imap/socket/idle
  311.         Unix domain    socket that idled listens on.
  312.  
  313. SSEEEE AALLSSOO
  314.        iimmaappdd((88)),   ppoopp33dd((88)),  llmmttppdd((88)),     ttiimmssiieevveedd((88)),    iiddlleedd((88)),
  315.        ddeelliivveerr((88)), mmaasstteerr((88))
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.  
  328. CMU              Project Cyrus                5
  329.  
  330.  
  331.